<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>xiltimer: xiltimer.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">xiltimer
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;"
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xiltimer_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xiltimer.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_timer_tag.html">XTimerTag</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Structure to the XFpga instance.  <a href="struct_x_timer_tag.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ad79fa109a0f7f136716e43b8931c468e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xiltimer_8h.html#ad79fa109a0f7f136716e43b8931c468e">XTIMER_MAJOR_VERSION</a>&#160;&#160;&#160;1U</td></tr>
<tr class="memdesc:ad79fa109a0f7f136716e43b8931c468e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Library Major version info.  <a href="#ad79fa109a0f7f136716e43b8931c468e">More...</a><br/></td></tr>
<tr class="separator:ad79fa109a0f7f136716e43b8931c468e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a372f9a921d5b640234b2a63a60f2a608"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xiltimer_8h.html#a372f9a921d5b640234b2a63a60f2a608">XTIMER_MINOR_VERSION</a>&#160;&#160;&#160;4U</td></tr>
<tr class="memdesc:a372f9a921d5b640234b2a63a60f2a608"><td class="mdescLeft">&#160;</td><td class="mdescRight">Library Minor version info.  <a href="#a372f9a921d5b640234b2a63a60f2a608">More...</a><br/></td></tr>
<tr class="separator:a372f9a921d5b640234b2a63a60f2a608"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a7ba0892098f95e0c742e64b51e97319b"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct_x_timer_tag.html">XTimerTag</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xiltimer_8h.html#a7ba0892098f95e0c742e64b51e97319b">XTimer</a></td></tr>
<tr class="memdesc:a7ba0892098f95e0c742e64b51e97319b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Structure to the XFpga instance.  <a href="#a7ba0892098f95e0c742e64b51e97319b">More...</a><br/></td></tr>
<tr class="separator:a7ba0892098f95e0c742e64b51e97319b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ac78bbfcf92781c4163433b9234ca5adb"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xiltimer_8h.html#ac78bbfcf92781c4163433b9234ca5adb">XTimer_DelayType</a> { <a class="el" href="xiltimer_8h.html#ac78bbfcf92781c4163433b9234ca5adba560abaa29cb456b69114f70412ecfb97">XTIMER_DELAY_SEC</a> = 1,
<a class="el" href="xiltimer_8h.html#ac78bbfcf92781c4163433b9234ca5adba4300457c5c502155d5683873c208873d">XTIMER_DELAY_MSEC</a> = 1000,
<a class="el" href="xiltimer_8h.html#ac78bbfcf92781c4163433b9234ca5adbaf87fdb94b9c9f134efde527a38db6048">XTIMER_DELAY_USEC</a> = 1000 * 1000
 }</td></tr>
<tr class="memdesc:ac78bbfcf92781c4163433b9234ca5adb"><td class="mdescLeft">&#160;</td><td class="mdescRight">This typedef contains different measures of time for the device.  <a href="xiltimer_8h.html#ac78bbfcf92781c4163433b9234ca5adb">More...</a><br/></td></tr>
<tr class="separator:ac78bbfcf92781c4163433b9234ca5adb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ae6ae23d2e575f47dcdd374cac14947ee"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xiltimer_8h.html#ae6ae23d2e575f47dcdd374cac14947ee">XilSleepTimer_Init</a> (<a class="el" href="xiltimer_8h.html#a7ba0892098f95e0c742e64b51e97319b">XTimer</a> *InstancePtr)</td></tr>
<tr class="memdesc:ae6ae23d2e575f47dcdd374cac14947ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">This API is used for initializing sleep timer.  <a href="#ae6ae23d2e575f47dcdd374cac14947ee">More...</a><br/></td></tr>
<tr class="separator:ae6ae23d2e575f47dcdd374cac14947ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a261d2e800b7b82eb41e3b8f8043a5c52"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xiltimer_8h.html#a261d2e800b7b82eb41e3b8f8043a5c52">XilTickTimer_Init</a> (<a class="el" href="xiltimer_8h.html#a7ba0892098f95e0c742e64b51e97319b">XTimer</a> *InstancePtr)</td></tr>
<tr class="memdesc:a261d2e800b7b82eb41e3b8f8043a5c52"><td class="mdescLeft">&#160;</td><td class="mdescRight">This API is used for initializing Tick timer.  <a href="#a261d2e800b7b82eb41e3b8f8043a5c52">More...</a><br/></td></tr>
<tr class="separator:a261d2e800b7b82eb41e3b8f8043a5c52"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d069e6cf82031c469818523a5d7ab82"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xiltimer_8h.html#a6d069e6cf82031c469818523a5d7ab82">XTime_GetTime</a> (XTime *Xtime_Global)</td></tr>
<tr class="memdesc:a6d069e6cf82031c469818523a5d7ab82"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the time.  <a href="#a6d069e6cf82031c469818523a5d7ab82">More...</a><br/></td></tr>
<tr class="separator:a6d069e6cf82031c469818523a5d7ab82"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac2d61518eafb79f1bad01cecb9503d6c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xiltimer__api.html#gac2d61518eafb79f1bad01cecb9503d6c">XTimer_SetInterval</a> (unsigned long delay)</td></tr>
<tr class="memdesc:gac2d61518eafb79f1bad01cecb9503d6c"><td class="mdescLeft">&#160;</td><td class="mdescRight">This API sets the elapse interval for the timer instance.  <a href="group__xiltimer__api.html#gac2d61518eafb79f1bad01cecb9503d6c">More...</a><br/></td></tr>
<tr class="separator:gac2d61518eafb79f1bad01cecb9503d6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6395671177518353e3ab5ded9609eb1e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xiltimer__api.html#ga6395671177518353e3ab5ded9609eb1e">XTimer_SetHandler</a> (XTimer_TickHandler FuncPtr, void *CallBackRef, u8 Priority)</td></tr>
<tr class="memdesc:ga6395671177518353e3ab5ded9609eb1e"><td class="mdescLeft">&#160;</td><td class="mdescRight">This routine installs an asynchronous callback function for the given FuncPtr.  <a href="group__xiltimer__api.html#ga6395671177518353e3ab5ded9609eb1e">More...</a><br/></td></tr>
<tr class="separator:ga6395671177518353e3ab5ded9609eb1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga30d16ade92d9b5d61797f69f06bdd7bb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xiltimer__api.html#ga30d16ade92d9b5d61797f69f06bdd7bb">XTimer_ClearTickInterrupt</a> (void)</td></tr>
<tr class="memdesc:ga30d16ade92d9b5d61797f69f06bdd7bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">This API clears the interrupt status of the tick timer instance.  <a href="group__xiltimer__api.html#ga30d16ade92d9b5d61797f69f06bdd7bb">More...</a><br/></td></tr>
<tr class="separator:ga30d16ade92d9b5d61797f69f06bdd7bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ad79fa109a0f7f136716e43b8931c468e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XTIMER_MAJOR_VERSION&#160;&#160;&#160;1U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Library Major version info. </p>

</div>
</div>
<a class="anchor" id="a372f9a921d5b640234b2a63a60f2a608"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XTIMER_MINOR_VERSION&#160;&#160;&#160;4U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Library Minor version info. </p>

</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="a7ba0892098f95e0c742e64b51e97319b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef struct <a class="el" href="struct_x_timer_tag.html">XTimerTag</a>  <a class="el" href="xiltimer_8h.html#a7ba0892098f95e0c742e64b51e97319b">XTimer</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Structure to the XFpga instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">XTimer_ModifyInterval</td><td>Modifies the timer interval </td></tr>
    <tr><td class="paramname">XTimer_TickIntrHandler</td><td>Tick interrupt handler </td></tr>
    <tr><td class="paramname">XTimer_TickInterval</td><td>Configures the tick interval </td></tr>
    <tr><td class="paramname">XSleepTimer_Stop</td><td>Stops the sleep timer </td></tr>
    <tr><td class="paramname">XTickTimer_Stop</td><td>Stops the tick timer </td></tr>
    <tr><td class="paramname">XTickTimer_ClearInterrupt</td><td>Clears the Tick timer interrupt status </td></tr>
    <tr><td class="paramname">Handler</td><td>Tick Handler </td></tr>
    <tr><td class="paramname">CallBackRef</td><td>Callback reference for handler </td></tr>
    <tr><td class="paramname">AxiTimer_SleepInst</td><td>Sleep Instance for AxiTimer </td></tr>
    <tr><td class="paramname">AxiTimer_TickInst</td><td>Tick Instance for AxiTimer </td></tr>
    <tr><td class="paramname">TtcPs_SleepInst</td><td>Sleep Instance for TTCPS </td></tr>
    <tr><td class="paramname">TtcPs_TickInst</td><td>Tick Instance for TTCPS </td></tr>
    <tr><td class="paramname">ScuTimer_SleepInst</td><td>Sleep Instance for Scutimer </td></tr>
    <tr><td class="paramname">ScuTimer_TickInst</td><td>Tick Instance for Scutimer </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="ac78bbfcf92781c4163433b9234ca5adb"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="xiltimer_8h.html#ac78bbfcf92781c4163433b9234ca5adb">XTimer_DelayType</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This typedef contains different measures of time for the device. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ac78bbfcf92781c4163433b9234ca5adba560abaa29cb456b69114f70412ecfb97"></a>XTIMER_DELAY_SEC</em>&nbsp;</td><td class="fielddoc">
<p>Time delay in seconds. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ac78bbfcf92781c4163433b9234ca5adba4300457c5c502155d5683873c208873d"></a>XTIMER_DELAY_MSEC</em>&nbsp;</td><td class="fielddoc">
<p>Time delay in milliseconds. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ac78bbfcf92781c4163433b9234ca5adbaf87fdb94b9c9f134efde527a38db6048"></a>XTIMER_DELAY_USEC</em>&nbsp;</td><td class="fielddoc">
<p>Time delay in microseconds. </p>
</td></tr>
</table>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ae6ae23d2e575f47dcdd374cac14947ee"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XilSleepTimer_Init </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="xiltimer_8h.html#a7ba0892098f95e0c742e64b51e97319b">XTimer</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This API is used for initializing sleep timer. </p>

<p>Referenced by <a class="el" href="group__xiltimer__api.html#gafd02bb0f6a745c39d5e3417493995c71">__attribute__()</a>.</p>

</div>
</div>
<a class="anchor" id="a261d2e800b7b82eb41e3b8f8043a5c52"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XilTickTimer_Init </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="xiltimer_8h.html#a7ba0892098f95e0c742e64b51e97319b">XTimer</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This API is used for initializing Tick timer. </p>

<p>Referenced by <a class="el" href="group__xiltimer__api.html#gafd02bb0f6a745c39d5e3417493995c71">__attribute__()</a>.</p>

</div>
</div>
<a class="anchor" id="a6d069e6cf82031c469818523a5d7ab82"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XTime_GetTime </td>
          <td>(</td>
          <td class="paramtype">XTime *&#160;</td>
          <td class="paramname"><em>Xtime_Global</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get the time. </p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
